Accept case insensitive values in boolean settings #10663

bernardodemarco · 2025-04-04T17:50:50Z

Description

Currently, when updating boolean settings, the Management Server performs a case sensitive validation of the inserted values. Thus, only the true and false values are accepted.

This PR proposes to extend this validation to encompass case insensitive boolean values. Therefore, values such as True and FALSE will be accepted and will be properly normalized before being persisted in the database.

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Screenshots (if appropriate):

How Has This Been Tested?

Verified that it was possible to update the quota.enable.service global setting to FaLsE.

updateConfiguration API execution

(acs-all-in-one) 🦌 > update configuration name="quota.enable.service" value="FaLsE"
{
  "configuration": {
    "category": "Advanced",
    "component": "QUOTA-PLUGIN",
    "defaultvalue": "false",
    "description": "Indicates whether Quota plugin is enabled or not.",
    "displaytext": "Quota enable service",
    "group": "Miscellaneous",
    "isdynamic": true,
    "name": "quota.enable.service",
    "subgroup": "Quota",
    "type": "Boolean",
    "value": "FaLsE"
  }
}

Persisted configuration value in the database

MariaDB [cloud]> select name,value from configuration where name = "quota.enable.service";
+----------------------+-------+
| name                 | value |
+----------------------+-------+
| quota.enable.service | false |
+----------------------+-------+
1 row in set (0.000 sec)

Verified that it was possible to update the setting value to TRUe:

updateConfiguration API execution

(acs-all-in-one) 🐓 > update configuration name="quota.enable.service" value="TRUe"
{
  "configuration": {
    "category": "Advanced",
    "component": "QUOTA-PLUGIN",
    "defaultvalue": "false",
    "description": "Indicates whether Quota plugin is enabled or not.",
    "displaytext": "Quota enable service",
    "group": "Miscellaneous",
    "isdynamic": true,
    "name": "quota.enable.service",
    "subgroup": "Quota",
    "type": "Boolean",
    "value": "TRUe"
  }
}

Persisted configuration value in the database

MariaDB [cloud]> select name,value from configuration where name = "quota.enable.service";
+----------------------+-------+
| name                 | value |
+----------------------+-------+
| quota.enable.service | true  |
+----------------------+-------+
1 row in set (0.000 sec)

bernardodemarco · 2025-04-04T17:51:12Z

@blueorangutan package

blueorangutan · 2025-04-04T17:52:03Z

@bernardodemarco a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2025-04-04T17:58:44Z

Codecov Report

Attention: Patch coverage is 80.95238% with 4 lines in your changes missing coverage. Please review.

Project coverage is 16.15%. Comparing base (823080c) to head (466c76d).
Report is 11 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
.../cloud/configuration/ConfigurationManagerImpl.java	80.95%	3 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               4.20   #10663   +/-   ##
=========================================
  Coverage     16.14%   16.15%           
- Complexity    13253    13273   +20     
=========================================
  Files          5656     5656           
  Lines        497893   497888    -5     
  Branches      60374    60373    -1     
=========================================
+ Hits          80405    80442   +37     
+ Misses       408529   408488   -41     
+ Partials       8959     8958    -1

Flag	Coverage Δ
uitests	`4.00% <ø> (ø)`
unittests	`17.00% <80.95%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

blueorangutan · 2025-04-04T18:58:56Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 12955

server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

bernardodemarco · 2025-05-06T19:55:00Z

@blueorangutan package

blueorangutan · 2025-05-06T19:56:04Z

@bernardodemarco a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-05-06T21:08:51Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13279

DaanHoogland

clgtm and unit tests provided. never the less I think this is such a cross cutting concern that it will need extensive testing.

DaanHoogland · 2025-05-07T06:28:06Z

@blueorangutan test

blueorangutan · 2025-05-07T06:30:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-05-07T22:49:58Z

[SF] Trillian test result (tid-13225)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 56037 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10663-t13225-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

erikbocks

I tested the changes in my local environment and everything worked as expected for booleans, strings, integers, and floats.

github-actions · 2025-05-27T18:50:41Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

JoaoJandre · 2025-06-02T19:35:06Z

@bernardodemarco could you fix the merge conflicts here?

bernardodemarco · 2025-06-04T17:33:21Z

@bernardodemarco could you fix the merge conflicts here?

Sure, done!

bernardodemarco · 2025-06-04T17:33:54Z

@blueorangutan package

bernardodemarco · 2025-06-04T17:34:53Z

@DaanHoogland @weizhouapache @Pearl1594, can we run the CI again for this one?

sureshanaparti · 2025-06-05T09:15:54Z

@blueorangutan package

blueorangutan · 2025-06-05T09:18:04Z

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-06-05T11:06:55Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 13612

DaanHoogland · 2025-06-09T12:45:29Z

@blueorangutan test

blueorangutan · 2025-06-09T12:46:03Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-06-10T04:43:02Z

[SF] Trillian test result (tid-13479)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 54482 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10663-t13479-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

bernardodemarco added this to the 4.20.1 milestone Apr 4, 2025

bernardodemarco added status:needs-testing status:needs-review labels Apr 4, 2025

winterhazel self-requested a review April 5, 2025 04:06

Pearl1594 added this to ACS 4.20.1 Apr 8, 2025

weizhouapache reviewed Apr 10, 2025

View reviewed changes

server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java Outdated Show resolved Hide resolved

server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java Show resolved Hide resolved

bernardodemarco requested review from weizhouapache and Pearl1594 May 6, 2025 19:54

DaanHoogland approved these changes May 7, 2025

View reviewed changes

erikbocks approved these changes May 23, 2025

View reviewed changes

bernardodemarco added status:ready-for-merge and removed status:needs-testing status:needs-review labels May 23, 2025

github-actions bot added the status:has-conflicts label May 27, 2025

DaanHoogland modified the milestones: 4.20.1, 4.20.2 Jun 3, 2025

bernardodemarco added 2 commits June 4, 2025 14:30

make boolean configs case insensitive

5f11e39

invert condition

466c76d

bernardodemarco force-pushed the make-boolean-configs-case-insensitive branch from 12f295d to 466c76d Compare June 4, 2025 17:32

github-actions bot removed the status:has-conflicts label Jun 4, 2025

DaanHoogland merged commit 8f2735a into apache:4.20 Jun 11, 2025
25 of 26 checks passed

github-project-automation bot moved this to Done in ACS 4.20.1 Jun 11, 2025

Accept case insensitive values in boolean settings #10663

Accept case insensitive values in boolean settings #10663

Uh oh!

Conversation

bernardodemarco commented Apr 4, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

bernardodemarco commented Apr 4, 2025

Uh oh!

blueorangutan commented Apr 4, 2025

Uh oh!

codecov bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Apr 4, 2025

Uh oh!

Uh oh!

Uh oh!

bernardodemarco commented May 6, 2025

Uh oh!

blueorangutan commented May 6, 2025

Uh oh!

blueorangutan commented May 6, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented May 7, 2025

Uh oh!

blueorangutan commented May 7, 2025

Uh oh!

blueorangutan commented May 7, 2025

Uh oh!

erikbocks left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 27, 2025

Uh oh!

JoaoJandre commented Jun 2, 2025

Uh oh!

bernardodemarco commented Jun 4, 2025

Uh oh!

bernardodemarco commented Jun 4, 2025

Uh oh!

bernardodemarco commented Jun 4, 2025

Uh oh!

sureshanaparti commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

blueorangutan commented Jun 5, 2025

Uh oh!

DaanHoogland commented Jun 9, 2025

Uh oh!

blueorangutan commented Jun 9, 2025

Uh oh!

blueorangutan commented Jun 10, 2025

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 4, 2025 •

edited

Loading